Remote APIs

Public Header

Public Request Header

Parameter	Description	Format	Remark
participantId	Identifies the financial institution that owns the account for which transactions are to be retrieved from history. This value must represent a valid value defined in the EASTPAY system. The valid values are dependent on the environment and must be at the time the interface is built. A response code of 01 is returned if this value is not present, is blank, or is not defined in the EASTPAY file	String, Maximum 15 characters	Required
tranBranch	Transaction branch	String, Maximum 6 characters	Required
tranChnl	Transaction channel	String ,2 characters	Required
tranCode	Transaction code	String, Maximum 30 characters	Optional
tranDate	Transaction date	8 characters	Required
tranTime	Transaction time	6 characters	Required
tranId	Transaction serial number	String, Maximum 32 characters	Required
tellerNo	The ID of the teller who  initiated the transaction	String, Maximum 32 characters	Optional
terminalNo	The ID of the terminal which initiated the transaction	String, Maximum15 characters	Optional

Public Response Header

Parameter	Description	Format	Remark
participantId	Identifies the financial institution that owns the account for which transactions are to be retrieved from history. This value must represent a valid value defined in the EASTPAY system. The valid values are dependent on the environment and must be at the time the interface is built. A response code of 01 is returned if this value is not present, is blank, or is not defined in the EASTPAY file	String, Maximum 15 characters	Required
tranBranch	Transaction branch	String, Maximum 6 characters	Required
tranChnl	Transaction channel	String ,2 characters	Required
tranCode	Transaction code	String, Maximum 30 characters	Optional
tranDate	Transaction date	8 characters	Required
tranTime	Transaction time	6 characters	Required
tranId	Transaction serial number	String, Maximum 32 characters	Required
tellerNo	The ID of the teller who  initiated the transaction	String, Maximum 32 characters	Optional
terminalNo	The ID of the terminal which initiated the transaction	String, Maximum15 characters	Optional
responseCode	Identifies the success or failure of the web service call. Valid values: 00 Successful 01 Invalid participant 02 Invalid CIF 03 Invalid CIF/Account status 05 Do not honour 12 Invalid transaction 13 Invalid amount 25 Original transactions not found 30 Invalid message formats 40 Unsupported functions 51 Insufficient funds 57 Transaction not permitted to cardholder 61 Amount limit exceeded 62 Restricted card 64 Original amount does not match 65 Count limit exceeded 91 System error 94 Duplicate transaction	Maximum 20 characters	Required
reponseDesc	Response code description	Maximum 120 characters	Required

Authorization

Authorization Introduction

Below are the main authorization transaction type for reference.

Parameter	Debit/Credit	Description
Authorization		Includes authorization for various business Debit Account scenarios such as withdrawals and purchases
Incremental authorization	Debit Account	Associates an original authorization with “oritranId” , used to increase the amount of an authorization or to extend the expiration date of an authorization.
Original Credit	Credit Account	Credit account (Money Send /Fund Transfer)
Refund	NA	Merchandise return authorization is optional and Eastpay will forward to your system if received.
Account verification	NA	Usually is a zero amount authorization
Balance Inquiry	NA	Request for balance information, often the result of a cardholder request at an ATM.

Note: Transaction type is not Transaction code(in public header”. The transaction code is an internal transaction code defined within the EastPay system based on some transaction factors such as the location of the transaction, card product, PAN entry method and so on. For example, intra-region purchase and inter-region purchase were treated as different transaction code in system. Transaction code is used to further break down the cost of service rules or general ledger processing.

Authorization Timeout

For authorization , incremental authorization and credit authorization , we receive an automatic Authorization Advice from card scheme whenever our response times out, for whatever reason. If authorization advice is received, consider it as the final status of the transaction. We will not initiate any additional reversal/void transactions, so please adjust the balance /accounting treatment (if needed) based on the results of the authorization advice.

Note:
Please treat authorization advice and authorization as two separate transactions; we do not always push authorization before we push authorization advice.

Authorization Message Layout

Request:

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels	Maximum 10 characters	Required	Card Scheme: VISA, MASTER, UPI, DINERS, AMEX On-us: MOBILE, TELLER
tranDesc	Transaction Description	Maximum 60 characters	Required
tranStatus	Transaction Status	Maximum 3 characters	Optional	Response code (DE39)
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
messageType	Message Type from card scheme MTI from card scheme, 0100,0200,0220,etc	Maximum 4 characters	Conditional
schemetranId	Transaction ID from Card Scheme	Maximum 36 characters	Optional	If received from card scheme
settleDate	Settlement Date	YYYYMMDD	Optional	Only for information ands may not be the actual settle date
tranCurrency	Transaction Currency	Maximum 3 character	Conditional
tranAmount	Transaction Amount	16,2	Conditional	No transaction amount information for balance inquiry
billCurrency	Bill Currency	Maximum 3 character	Conditional	If received, then forward
billAmount	Bill Amount	16,2	Conditional	If received
settleCurrency	Settlement Currency	Maximum 3 character	Conditional	If received
settleAmount	Settlement Amount	16,2	Conditional	If received
markupFee	Markup Fee	16,2	Required	Markup fee calculated by EastPay if configured
acquirerFee	Acquirer Fee	16,2	Conditional	If received
reasonCode	Reason Code	Maximum 20 characters	Optional	Message reason code of online authorization
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
panEntryMode	PAN Entry Mode	Maximum 2 characters	Required
pinEntryMode	PIN Entry Mode	Maximum 1 characters	Required
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
terminalAttendance	Terminal Attendance	Maximum 1 characters	Conditional	If received
cardholderPresence	Cardholder Presence	Maximum 1 characters	Conditional	If received
cardPresence	Card Presence	Maximum 1 characters	Conditional	If received
authenticationMethod	Cardholder Authentication Method	Maximum 10 characters	Required	Authentication method of CNP transactions
billAddress	Cardholder bill address	Maximum 40 characters	If recieved for AVS Conditional verification
billAddressZipcode	Zipcode of cardholder bill address	Maximum 9 characters	Conditional	If recieved for AVS verification
networkTokenId	VTS or MDES token ID	Maximum 32 characters	Conditional	If received
networkTokenType	Token type	Maximum 2 characters	Conditional	If received
networkTokenStatus	Token status indicator	Maximum 1 characters	Conditional	If received
networkTokenExp	Expiration date of the token	Maximum 1 characters	Conditional	If received
networkTokenScore	Token risk socre	Maximum 2 characters	Conditional	If received
tokenRequestorId	Token Requestor Id assigned by card schemel	Maximum 32 characters	Conditional	If recieved
tokenRequestorName	Token Request Name	Maximum 32 characters	Conditional	If received
deviceType	Device Type	Maximum 2 characters	Conditional	If received
deviceLanguage	Language Code	Maximum 3 characters	Conditional	If received
deviceId	Device Id	Maximum 48 characters	Conditional	If received
devicePhone	Mobile Phone	Maximum 25 characters	Conditional	If received
deviceName	Device Name	Maximum 25 characters	Conditional	If received
deviceIP	Ip address	Maximum 40 characters	Conditional	If received
deviceLocation	GPS location	Maximum 25 characters	Conditional	If received
cvvResponse	CVV Response	Maximum 1 characters	Optional	CVV match flag from EastPay
avsResult	AVS Result	Maximum 1 characters	Optional	AVS match flag from EastPay
cavvResult	CAVV Result	Maximum 1 characters	Optional	ACS CAVV match flag from Eastpay
dccIndicator	DCC Transaction Indicator	Maximum 1 characters	Conditional	If received
isRecurring	Is Recurring	Maximum 1 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
moneySendData	Mastercard Money Send Information	Maximum 999 characters	Optional	Mastercard Money send transaction information
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Transaction Fee calculated by EastPay if configured
tranScore	Transaction score from Visa or Mastercard	Maximum 32 characters	Conditional	If received
acctScore	Compromised Account Risk	Maximum 3 characters	Conditional	If received
cardProdCode	Card Product Code	Maximum 4 characters	Optional

Response:

Field Name	Description	Format	Required	Remark
coretranId	Unique transaction id in your system	Maximum 64 characters	Required	For recon purpose
errorCode	Error Code in your system	Maximum 20 characters	Conditional	EastPay will use your errorCode to map to scheme’s response code if needed
errorDesc	Error Description	Maximum 30 characters	Conditional
acctBalance	Account balance	Number 16,2	Conditional	Required for balance inquiry and ATM withdrawnsaction
avaiBalance	Available balance	Number 16,2	Conditional	Required for balance inquiry and ATM withdrawnsaction
blockBalance	Block balance	Number 16,2	Optional
acctCurrency	Account Currency	Maximum 3 characters	Conditional	Required for balance inquiry and ATM withdrawnsaction
adviceCode	Merchant Advice Code	Maximum 2 characters	Optional

Authorization Advice

Authorization Advice Introduction

All card scheme stand-in transactions are sent via an authorization advice, such as the

1. Card scheme’s positive/negative stand-in authorization
2. Transactions declined directly on EastPay according to the rules set by the card issuer.
3. Advice triggered because no response was given to the card group due to timeout or error in our system.

Our system will try to match the authorization advice with the original authorization, we will send the authorization’s TranId in oriTranId filed of authorization advice if matched.

Authorization Advice Message Layout

Request:

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels such as mobile banking, over-the-counter, etc.	Maximum 10 characters	Required	Card Scheme: VISA, MASTER, UPI, DINERS, AMEX On-us: MOBILE, TELLER
tranType	Transaction Type characters	Maximum 30 characters	Required	C: withdraw D: Credit E: Enquiry G: Purchase H: Refund R: Account Verification
tranDesc	Transaction Description	Maximum 60 characters	Required
tranStatus	Transaction Status	Maximum 3 characters	Optional	Response code (DE39)
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
messageType	Message Type from card scheme MTI from card scheme, 0100,0200,0220,etc	Maximum 4 characters	Conditional
schemetranId	Transaction ID from Card Scheme	Maximum 36 characters	Optional	If received from card scheme
settleDate	Settlement Date	YYYYMMDD	Optional	Only for information ands may not be the actual settle date
amountDrCr	Debit or Credit indicator Valid Value: D = debit C= credit	Maximum 1 character	Conditional	If transaction amount appears
tranCurrency	Transaction Currency	Maximum 3 character	Conditional
tranAmount	Transaction Amount	16,2	Conditional	No transaction amount information for balance inquiry
billCurrency	Bill Currency	Maximum 3 character	Conditional	If received, then forward
billAmount	Bill Amount	16,2	Conditional	If received
settleCurrency	Settlement Currency	Maximum 3 character	Conditional	If received
settleAmount	Settlement Amount	16,2	Conditional	If received
markupFee	Markup Fee	16,2	Required	Markup fee calculated by EastPay if configured
acquirerFee	Acquirer Fee	16,2	Conditional	If received
reasonCode	Reason Code	Maximum 20 characters	Optional	Message reason code of online authorization
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
panEntryMode	PAN Entry Mode	Maximum 2 characters	Required
pinEntryMode	PIN Entry Mode	Maximum 1 characters	Required
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
terminalAttendance	Terminal Attendance	Maximum 1 characters	Conditional	If received
cardholderPresence	Cardholder Presence	Maximum 1 characters	Conditional	If received
cardPresence	Card Presence	Maximum 1 characters	Conditional	If received
authenticationMethod	Cardholder Authentication Method	Maximum 10 characters	Required	Authentication method of CNP transactions
billAddress	Cardholder bill address	Maximum 40 characters	If recieved for AVS Conditional verification
billAddressZipcode	Zipcode of cardholder bill address	Maximum 9 characters	Conditional	If recieved for AVS verification
networkTokenId	VTS or MDES token ID	Maximum 32 characters	Conditional	If received
networkTokenType	Token type	Maximum 2 characters	Conditional	If received
networkTokenStatus	Token status indicator	Maximum 1 characters	Conditional	If received
networkTokenExp	Expiration date of the token	Maximum 1 characters	Conditional	If received
networkTokenScore	Token risk socre	Maximum 2 characters	Conditional	If received
tokenRequestorId	Token Requestor Id assigned by card schemel	Maximum 32 characters	Conditional	If recieved
tokenRequestorName	Token Request Name	Maximum 32 characters	Conditional	If received
deviceType	Device Type	Maximum 2 characters	Conditional	If received
deviceLanguage	Language Code	Maximum 3 characters	Conditional	If received
deviceId	Device Id	Maximum 48 characters	Conditional	If received
devicePhone	Mobile Phone	Maximum 25 characters	Conditional	If received
deviceName	Device Name	Maximum 25 characters	Conditional	If received
deviceIP	Ip address	Maximum 40 characters	Conditional	If received
deviceLocation	GPS location	Maximum 25 characters	Conditional	If received
cvvResponse	CVV Response	Maximum 1 characters	Optional	CVV match flag from EastPay
avsResult	AVS Result	Maximum 1 characters	Optional	AVS match flag from EastPay
cavvResult	CAVV Result	Maximum 1 characters	Optional	ACS CAVV match flag from Eastpay
dccIndicator	DCC Transaction Indicator	Maximum 1 characters	Conditional	If received
isRecurring	Is Recurring	Maximum 1 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
moneySendData	Mastercard Money Send Information	Maximum 999 characters	Optional	Mastercard Money send transaction information
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Transaction Fee calculated by EastPay if configured
tranScore	Transaction score from Visa or Mastercard	Maximum 32 characters	Conditional	If received
acctScore	Compromised Account Risk	Maximum 3 characters	Conditional	If received
cardProdCode	Card Product Code	Maximum 4 characters	Optional

Response: None, only response public header.

Reversal Message

Reversal Introduction

Reversal transactions are usually triggered automatically due to a system timeout or system error. And sometime it is initiated by the cardholder or merchant for purchase cancellation. It can be associated with the original authorization using oritranId, but the amount may be the same as the original authorization or only partial.

Reversal Message Layout

Request:

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels	Maximum 10 characters	Required	Card Scheme: VISA, MASTER, UPI, DINERS, AMEX On-us: MOBILE, TELLER
tranType	Transaction Type characters	Maximum 30 characters	Required	C: withdraw D: Credit E: Enquiry G: Purchase H: Refund R: Account Verification
tranDesc	Transaction Description	Maximum 60 characters	Required
tranStatus	Transaction Status	Maximum 3 characters	Optional	Response code (DE39)
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
messageType	Message Type from card scheme MTI from card scheme, 0100,0200,0220,etc	Maximum 4 characters	Conditional
settleDate	Settlement Date	YYYYMMDD	Optional	Only for information ands may not be the actual settle date
tranCurrency	Transaction Currency	Maximum 3 character	Required
tranAmount	Transaction Amount	16,2	Required	No transaction amount information for balance inquiry
billCurrency	Bill Currency	Maximum 3 character	Required	If received, then forward
billAmount	Bill Amount	16,2	Required	If received
settleCurrency	Settlement Currency	Maximum 3 character	Required	If received
settleAmount	Settlement Amount	16,2	Required	If received
interchangeFee	Interchange Fee	16,2	Required	If received
otherFee	Other Fee	16,2	Conditional	If received
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
arn	Acquirer reference number/data	Maximum 23 characters	Required
rvslIndicator	Reversal Indicator	Maximum 1 character	Conditional	R:reversal
partialIndicator	Partial Settlement Indicator	Maximum 1 character	Conditional	0:Full 1:Partial
reasonCode	reasonCode	Maximum 20 characters	Conditional	If received
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Transaction Fee calculated by EastPay if configured
cardProdCode	Card Product Code	Maximum 4 characters	Optional

Response:

Note: Visa and Discover do not allow failure response, the response to a reversal transaction must be successful.

Field Name	Description	Format	Required	Remark
coretranId	Unique transaction id in your system	Maximum 64 characters	Required	For recon purpose
errorCode	Error Code in your system	Maximum 20 characters	Optional	EastPay will use your errorCode to map to scheme’s response code if needed
errorDesc	Error Description	Maximum 30 characters	Optional
acctBalance	Account balance	Number 16,2	Optional
avaiBalance	Available balance	Number 16,2	Optional
blockBalance	Block balance	Number 16,2	Optional
acctCurrency	Account Currency	Maximum 3 characters	Optional

Capture ( Optional )

Capture Introduction

If there was an authorzation before the capture, then oritranId in the capture request is the transaction id of the authorized transaction. If the acquirer cancel the capture, then EastPay sends another capture to your system, where the oritranId is unchanged but the rvslIndicator will be “R”.
It can happen that an authorization receives multiple captures or that an authorization remains uncaptured until the authorization expires.

Capture Message Layout

Request:

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels	Maximum 10 characters	Required	Card Scheme: VISA, MASTER, UPI, DINERS, AMEX On-us: MOBILE, TELLER
tranType	Transaction Type characters	Maximum 30 characters	Required	C: withdraw D: Credit E: Enquiry G: Purchase H: Refund R: Account Verification
tranDesc	Transaction Description	Maximum 60 characters	Required
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
messageType	Message Type from card scheme MTI from card scheme, 0100,0200,0220,etc	Maximum 4 characters	Conditional
settleDate	Settlement Date	YYYYMMDD	Optional
amountDrCr	Debit or Credit indicator Valid Value: D = debit C= credit	Maximum 1 character	Conditional	If transaction amount appears
tranCurrency	Transaction Currency	Maximum 3 character	Required
tranAmount	Transaction Amount	16,2	Required	No transaction amount information for balance inquiry
billCurrency	Bill Currency	Maximum 3 character	Required	If received, then forward
billAmount	Bill Amount	16,2	Required	If received
settleCurrency	Settlement Currency	Maximum 3 character	Required	If received
settleAmount	Settlement Amount	16,2	Required	If received
interchangeFee	Interchange Fee	16,2	Required	If received
otherFee	Other Fee	16,2	Conditional	If received
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
arn	Acquirer reference number/data	Maximum 23 characters	Required
rvslIndicator	Reversal Indicator	Maximum 1 character	Conditional	R:reversal
partialIndicator	Partial Settlement Indicator	Maximum 1 character	Conditional	0:Full 1:Partial
reasonCode	reasonCode	Maximum 20 characters	Conditional	If received
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Transaction Fee calculated by EastPay if configured
cardProdCode	Card Product Code	Maximum 4 characters	Optional

Response:

Field Name	Description	Format	Required	Remark

Dispute (Chargeback) (Optional)

Dispute (Chargeback) Message Layout

Request:

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels	Maximum 10 characters	Required	Card Scheme: VISA, MASTER, UPI, DINERS, AMEX On-us: MOBILE, TELLER
tranType	Transaction Type characters	Maximum 30 characters	Required	C: withdraw D: Credit E: Enquiry G: Purchase H: Refund R: Account Verification
tranDesc	Transaction Description	Maximum 60 characters	Required
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Required	Original Authorization transaction id
settleDate	Settlement Date	YYYYMMDD	Optional
tranCurrency	Transaction Currency	Maximum 3 character	Required	Dispute/Chargeback amount currency
tranAmount	Transaction Amount	16,2	Required	Dispute/Chargeback Amount
billCurrency	Bill Currency	Maximum 3 character	Required	If received, then forward
billAmount	Bill Amount	16,2	Required	If received
settleCurrency	Settlement Currency	Maximum 3 character	Required	If received
settleAmount	Settlement Amount	16,2	Required	If received
interchangeFee	Interchange Fee	16,2	Required	If received
otherFee	Other Fee	16,2	Conditional	If received
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
arn	Acquirer reference number/data	Maximum 23 characters	Required
disputeId	Chargeback Reference ID / Dispute Case ID	Maximum 20 characters	Required
disputeReason	Dispute / Chargeback reason	Maximum 20 characters	Required
rvslIndicator	Reversal Indicator	Maximum 1 character	Conditional	R:reversal
reasonCode	reasonCode	Maximum 20 characters	Conditional	If received
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Dispute/Chargeback Fee calculated by EastPay if configured
cardProdCode	Card Product Code	Maximum 4 characters	Optional

Response:

None, only response public header.

Retrieve Transaction

Retrieve Transaction Introduction

Retrieve Transaction is for your system to retrieve the authorization transaction detail and clearing transaction detail.

Message Layout

Request:

Field Name	Description	Format	Required	Remark
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
arn	Acquirer reference number/data	Maximum 23 characters	Required

Filling in either of the oritranId and ARN will work. If both are present but do not match, you will receive an error message. If your put oritranId in request , the response will include the authorization information and clearing information if captured and dispute information if have .
If you only put arn in request , the response will include the clearing detail and dispute information related the arn.

Response:

Field Name	Description	Format	M/O
recordNum	Record Number	Maximum 8 character	Required
recordList	each element is a complex element that includes the following sub-elements:

Sub-element :

Field Name	Description	Format	Required	Remark
msgChannel	Message Channel usually represents the source of the transaction, which can be a card group or various internal transaction channels	Maximum 10 characters	Required
tranType	Transaction Type characters	Maximum 30 characters	Required	C: withdraw D: Credit E: Enquiry G: Purchase H: Refund R: Account Verification
tranDesc	Transaction Description	Maximum 60 characters	Required
tranStatus	Transaction Status	Maximum 3 characters	Optional	Response code (DE39)
cardToken	Card Token Number	Maximum 19 characters	Required
cardNumber	Masked Card Number	Maximum 19 character	Required	First 6 digits and last 4 digits
oritranId	Original Transaction ID	Maximum 32 characters	Conditional
arn	Acquirer reference number/data	Maximum 23 characters	Conditional
disputeId	Chargeback Reference ID / Dispute Case ID	Maximum 20 characters	Required
disputeReason	Dispute / Chargeback reason	Maximum 20 characters	Required
rvslIndicator	Reversal Indicator	Maximum 1 character	Conditional	R:reversal
reasonCode	reasonCode	Maximum 20 characters	Conditional	If received
settleDate	Settlement Date	YYYYMMDD	Optional
tranCurrency	Transaction Currency	Maximum 3 character	Conditional
tranAmount	Transaction Amount	16,2	Conditional	No transaction amount information for balance inquiry
billCurrency	Bill Currency	Maximum 3 character	Conditional	If received, then forward
billAmount	Bill Amount	16,2	Conditional	If received
settleCurrency	Settlement Currency	Maximum 3 character	Conditional	If received
settleAmount	Settlement Amount	16,2	Conditional	If received
markupFee	Markup Fee	16,2	Required	Markup fee calculated by EastPay if configured
acquirerFee	Acquirer Fee	16,2	Conditional	If received
interchangeFee	Interchange Fee	16,2	Conditional	If received
merchantId	Merchant Id	Maximum 15 characters	Conditional	If received
merchantName	Merchant Name	Maximum 40 characters	Required
mcc	Merchant Category Code	Maximum 4 characters	Required
merchantAddress	Merchant Address	Maximum 50 characters	Optional
merchantCity	Merchant City	Maximum 25 characters	Optional
merchantState	Merchant State	Maximum 25 characters	Optional
merchantPostalCode	Merchant Postale	Maximum 15 characters	Optional
merchantCountry	Merchantntry	Maximum 3 characters	Optional
merchantContact	Merchant Contact	Maximum 25 characters	Optional
merchantUrl	Merchant URL	Maximum 255 characters	Optional
merchantEmail	Merchant email	Maximum 40 characters	Optional
merchantMisc	Merchant Miscellaneous	Maximum 255 characters	Optional	Miscellaneous information if received, including MVVID ,TAX ID ,…etc
institutionCode	Acquirer Institution Code	Maximum 11 characters	Required
serviceCountry	Service Country	Maximum 3 characters	Optional
retReferenceNo	Retrieval Reference Number	Maximum 12 characters	Conditional	If received DE37
sysTraceAuditNo	System Trace Audit Number	Maximum 6 characters	Required	STAN(DE11)
panEntryMode	PAN Entry Mode	Maximum 2 characters	Required
pinEntryMode	PIN Entry Mode	Maximum 1 characters	Required
terminalId	Terminal Id	Maximum 8 characters	Conditional	If received
terminalAttendance	Terminal Attendance	Maximum 1 characters	Conditional	If received
cardholderPresence	Cardholder Presence	Maximum 1 characters	Conditional	If received
cardPresence	Card Presence	Maximum 1 characters	Conditional	If received
authenticationMethod	Cardholder Authentication Method	Maximum 10 characters	Required	Authentication method of CNP transactions
billAddress	Cardholder bill address	Maximum 40 characters	Conditional	If recieved for AVS verification
billAddressZipcode	Zipcode of cardholder bill address	Maximum 9 characters	Conditional	If recieved for AVS verification
networkTokenId	VTS or MDES token ID	Maximum 32 characters	Conditional	If received
networkTokenType	Token type	Maximum 2 characters	Conditional	If received
networkTokenStatus	Token status indicator	Maximum 1 characters	Conditional	If received
networkTokenExp	Expiration date of the token	Maximum 1 characters	Conditional	If received
networkTokenScore	Token risk socre	Maximum 2 characters	Conditional	If received
tokenRequestorId	Token Requestor Id assigned by card schemel	Maximum 32 characters	Conditional	If recieved
tokenRequestorName	Token Request Name	Maximum 32 characters	Conditional	If received
deviceType	Device Type	Maximum 2 characters	Conditional	If received
deviceLanguage	Language Code	Maximum 3 characters	Conditional	If received
deviceId	Device Id	Maximum 48 characters	Conditional	If received
devicePhone	Mobile Phone	Maximum 25 characters	Conditional	If received
deviceName	Device Name	Maximum 25 characters	Conditional	If received
deviceIP	Ip address	Maximum 40 characters	Conditional	If received
deviceLocation	GPS location	Maximum 25 characters	Conditional	If received
cvvResponse	CVV Response	Maximum 1 characters	Optional	CVV match flag from EastPay
avsResult	AVS Result	Maximum 1 characters	Optional	AVS match flag from EastPay
dccIndicator	DCC Transaction Indicator	Maximum 1 characters	Conditional	If received
isRecurring	Is Recurring	Maximum 1 characters	Conditional	If received
additionData	Addition Data	Maximum 999 characters	Optional	Additional information from initiator
moneySendData	Mastercard Money Send Information	Maximum 999 characters	Optional	Mastercard Money send transaction information
approvalCode	Approval Code	maximum 6	Optional	Approval code generated by EastPay for successful transaction
acctNumber	Linked Account Number	Maximum 25 characters	Conditional	If configured in EastPay system
acctCurrency	Linked Account Currency	Maximum 3 characters	Conditional	If configured in EastPay system
customerId	Customer unique ID	Maximum 32 characters	Optional
feeAmt	Fee Amount	Number 16,2	Optional	Transaction Fee calculated by EastPay if configured
tranScore	Transaction score from Visa or Mastercard	Maximum 32 characters	Conditional	If received
acctScore	Compromised Account Risk	Maximum 3 characters	Conditional	If received
cardProdCode	Card Product Code	Maximum 4 characters	Optional